feat(auto-edits): adding autoedits onboarding setup for dotcom users #6463

hitesh-1997 · 2024-12-26T06:44:40Z

The PR adds onboarding workflow for the auto-edits feature.
We first check if the user is eligible for the auto-edits feature based on the conditions:

User needs to be in vscode editor.
If dotcom authenticated, only pro users allowed.
User has to be in the backend feature flag.

If the user is eligible to try auto-edits, we show a pop up to the user (max 3 times). Clicking on the pop-up enables auto-edits for the user.

@aramaraju Does the conditions above looks okay to you ?

auto-edits.onboarding.mp4

Test plan

CI

valerybugakov · 2025-01-07T06:46:12Z

vscode/src/autoedits/create-autoedits-provider.ts

+                !isUserEligibleForAutoeditsFeature(
+                    autoeditsFeatureFlagEnabled,
+                    authStatus,
+                    userProductSubscription
+                )


Can we move this check one level higher to the registerAutoEdits function in main.ts. If a user is not eligible, we should not attempt to call the createAutoEditsProvider function.

any specific reason why main.ts could be better here ?
I liked it here since that puts all the logic for creating/decide if not to create provider in a single place. Also, if the logic becomes more complex (such as the proposal to show pop-up to the non eligible users ) we want to add condition under the if, so we can do this in the same file.

Do you think it would be okay to just keep it here ?

I assumed we still have a check for the feature flag at the top level, but now I see that we moved all conditions into one place. That was the primary purpose of this suggestion 👍

valerybugakov · 2025-01-07T06:47:47Z

vscode/src/autoedits/create-autoedits-provider.ts

+                )
+            ) {
+                throw new Error(
+                    'User is not eligible for auto-edits. Can not initialize auto-edits provider.'


It would be helpful for debugging if we named the reason here or at least logged it to the output channel. That way, when users come to us with questions about this error, we can triage it faster.

Added the message which we will show to the user as per the discussion. A quick snapshot below, when free user tried to access auto-edits:

valerybugakov · 2025-01-07T06:48:59Z

vscode/src/autoedits/autoedit-onboarding.ts

+    private async getAutoEditsOnboardingNotificationCount(): Promise<number> {
+        return await localStorage.getAutoEditsOnboardingNotificationCount()
+    }


nit: no need to await in cases where we only need to return a promise

Suggested change

private async getAutoEditsOnboardingNotificationCount(): Promise<number> {

return await localStorage.getAutoEditsOnboardingNotificationCount()

}

private getAutoEditsOnboardingNotificationCount(): Promise<number> {

return localStorage.getAutoEditsOnboardingNotificationCount()

}

valerybugakov · 2025-01-07T06:51:21Z

vscode/src/autoedits/autoedit-onboarding.ts

+
+    private async isUserEligibleForAutoeditsOnboarding(): Promise<boolean> {
+        const authStatus = currentAuthStatus()
+        const productSubsubscription = await currentUserProductSubscription()


Suggested change

const productSubsubscription = await currentUserProductSubscription()

const productSubscription = await currentUserProductSubscription()

valerybugakov · 2025-01-07T06:58:53Z

vscode/src/autoedits/create-autoedits-provider.ts

+export function isUserEligibleForAutoeditsFeature(
+    autoeditsFeatureFlagEnabled: boolean,
+    authStatus: AuthStatus,
+    productSubsubscription: UserProductSubscription | null


Suggested change

productSubsubscription: UserProductSubscription | null

productSubscription: UserProductSubscription | null

valerybugakov · 2025-01-07T07:03:17Z

vscode/src/autoedits/autoedit-onboarding.ts

+
+    private async isAutoeditsNotificationsUnderLimit(): Promise<boolean> {
+        const count = await this.getAutoEditsOnboardingNotificationCount()
+        return count < this.MAX_AUTO_EDITS_ONBOARDING_NOTIFICATIONS


If we decide to show it multiple times, we should add a progressive timeout between prompts to avoid coming across as spammy.

added the min 1 hour timeout between 2 calls

vscode/src/autoedits/autoedit-onboarding.ts

toolmantim · 2025-01-07T22:56:10Z

vscode/src/autoedits/autoedit-onboarding.ts

+        const selection = await vscode.window.showInformationMessage(
+            '✨ Try Cody auto-edits: Experimental feature which suggests advanced context-aware code edits as you navigate the codebase',
+            'Enable auto-edits'
+        )


Can we add a "Don't Show Again" option here? (like

cody/vscode/src/notifications/cody-pro-expiration.ts

Line 34 in fabed61

public static readonly noThanksText = 'Don’t Show Again'

)? Otherwise people will get asked 3 times, yes, even if they're not interested?

added the text

toolmantim · 2025-01-07T22:58:22Z

vscode/src/autoedits/autoedit-onboarding.ts

+                    vscode.ConfigurationTarget.Global
+                )
+
+            // Open VS Code settings UI and focus on the Cody Autoedits setting


What's the thinking behind opening the settings panel?

This is to make them aware where to find the settings in case they want to turn on/off or switch between autocomplete/auto-edits.

toolmantim · 2025-01-07T22:58:54Z

vscode/src/autoedits/autoedit-onboarding.ts

+    private async showAutoeditsOnboardingPopup(): Promise<void> {
+        const selection = await vscode.window.showInformationMessage(
+            '✨ Try Cody auto-edits: Experimental feature which suggests advanced context-aware code edits as you navigate the codebase',
+            'Enable auto-edits'


Suggested change

'Enable auto-edits'

'Enable Auto-Edits'

toolmantim · 2025-01-07T23:03:07Z

vscode/src/autoedits/autoedit-onboarding.ts

+
+    private async showAutoeditsOnboardingPopup(): Promise<void> {
+        const selection = await vscode.window.showInformationMessage(
+            '✨ Try Cody auto-edits: Experimental feature which suggests advanced context-aware code edits as you navigate the codebase',


Suggested change

'✨ Try Cody auto-edits: Experimental feature which suggests advanced context-aware code edits as you navigate the codebase',

'Try Cody Auto-Edits (experimental)? Cody will intelligently suggest next edits as you navigate the codebase.',

I don't love "as you navigate the codebase" though — does this trigger when you just open files, or when you're actively working on a file, or…?

Ah, I just realised this feature replaces the standard autocomplete behaviour too, which people probably have a very strong familiarity with. Is it easy to toggle this feature on/off via the Cody statusbar menu in the bottom right corner?

"as you navigate the codebase" seems to reflect that user doesn't have to type anything to get suggestions, they can get suggestion even if they move the cursor in the file.
Yes, they can get suggestion even if you just open the file. One example is - if user have made modification in some other files, model might suggest the change in the current file based on where your cursor is currently placed

Is it easy to toggle this feature on/off via the Cody statusbar menu in the bottom right corner?

Not yet, I think it is still experimental and when users click "enable auto-edits" we take them to the settings so that they know where to switch between auto-edits and autocomplete.

vscode/src/autoedits/autoedit-onboarding.ts

valerybugakov · 2025-01-09T04:03:30Z

vscode/src/autoedits/autoedit-onboarding.ts

+
+export class AutoeditsOnboarding implements vscode.Disposable {
+    private readonly MAX_AUTO_EDITS_ONBOARDING_NOTIFICATIONS = 3
+    private readonly MIN_TIME_DIFF_AUTO_EDITS_BETWEEN_NOTIFICATIONS_MS = 60 * 60 * 1000 // 1 hour


valerybugakov

Great! Going to include this in the next pre-release!

hitesh-1997 force-pushed the hitesh/autoedit-onboarding-setup branch from 742874b to ab9ec69 Compare December 27, 2024 11:39

hitesh-1997 force-pushed the hitesh/autoedit-onboarding-setup branch 2 times, most recently from b08f12a to 81b0302 Compare January 6, 2025 15:24

hitesh-1997 changed the base branch from main to hitesh/make-autoedits-reactive January 6, 2025 15:25

hitesh-1997 force-pushed the hitesh/make-autoedits-reactive branch from 2018bc0 to 0f22a0e Compare January 6, 2025 21:39

hitesh-1997 force-pushed the hitesh/autoedit-onboarding-setup branch from ab63f60 to 0fb8d6d Compare January 6, 2025 21:40

hitesh-1997 requested review from valerybugakov and umpox January 6, 2025 22:12

hitesh-1997 marked this pull request as ready for review January 6, 2025 22:12

valerybugakov reviewed Jan 7, 2025

View reviewed changes

hitesh-1997 mentioned this pull request Jan 7, 2025

suggestion mode UI #6523

Merged

hitesh-1997 changed the title ~~adding autoedits onboarding setup for dotcom users~~ feat(auto-edits): adding autoedits onboarding setup for dotcom users Jan 7, 2025

hitesh-1997 commented Jan 7, 2025

View reviewed changes

vscode/src/autoedits/autoedit-onboarding.ts Show resolved Hide resolved

toolmantim reviewed Jan 7, 2025

View reviewed changes

Base automatically changed from hitesh/make-autoedits-reactive to main January 8, 2025 10:36

hitesh-1997 added 10 commits January 8, 2025 16:23

adding autoedits onboarding setup for dotcom users

a8641e8

add user onboarding for auto-edits

17cbc10

improve message

0051452

clean option

7d6df51

add user eligibility condition for autoedits

3451c3f

add onboarding

570ebe4

add onboarding

91dfd12

add time difference between consecutive notifications

7c23a46

add message for non-eligible users when they select auto-edits

2730e37

address pr review comments

ba9805e

hitesh-1997 force-pushed the hitesh/autoedit-onboarding-setup branch from 57d3094 to ba9805e Compare January 8, 2025 11:12

hitesh-1997 added 2 commits January 8, 2025 16:48

fix lint

998f66e

add option to switch to autocomplete for non-eligible users

0d62c0f

hitesh-1997 enabled auto-merge (squash) January 8, 2025 21:55

Merge branch 'main' into hitesh/autoedit-onboarding-setup

326b010

valerybugakov reviewed Jan 9, 2025

View reviewed changes

valerybugakov approved these changes Jan 9, 2025

View reviewed changes

hitesh-1997 merged commit e5f790c into main Jan 9, 2025
21 of 22 checks passed

hitesh-1997 deleted the hitesh/autoedit-onboarding-setup branch January 9, 2025 04:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(auto-edits): adding autoedits onboarding setup for dotcom users #6463

feat(auto-edits): adding autoedits onboarding setup for dotcom users #6463

hitesh-1997 commented Dec 26, 2024 •

edited

Loading

valerybugakov Jan 7, 2025

hitesh-1997 Jan 7, 2025 •

edited

Loading

valerybugakov Jan 7, 2025

valerybugakov Jan 7, 2025

hitesh-1997 Jan 7, 2025 •

edited

Loading

valerybugakov Jan 7, 2025

hitesh-1997 Jan 7, 2025

valerybugakov Jan 7, 2025

hitesh-1997 Jan 7, 2025

valerybugakov Jan 7, 2025

hitesh-1997 Jan 7, 2025

valerybugakov Jan 7, 2025

hitesh-1997 Jan 7, 2025

toolmantim Jan 7, 2025

hitesh-1997 Jan 8, 2025

toolmantim Jan 7, 2025

hitesh-1997 Jan 8, 2025

toolmantim Jan 7, 2025

hitesh-1997 Jan 8, 2025

toolmantim Jan 7, 2025

toolmantim Jan 7, 2025

hitesh-1997 Jan 8, 2025

hitesh-1997 Jan 8, 2025 •

edited

Loading

valerybugakov Jan 9, 2025

valerybugakov left a comment

	const productSubsubscription = await currentUserProductSubscription()
	const productSubscription = await currentUserProductSubscription()

	productSubsubscription: UserProductSubscription \| null
	productSubscription: UserProductSubscription \| null

	'✨ Try Cody auto-edits: Experimental feature which suggests advanced context-aware code edits as you navigate the codebase',
	'Try Cody Auto-Edits (experimental)? Cody will intelligently suggest next edits as you navigate the codebase.',

feat(auto-edits): adding autoedits onboarding setup for dotcom users #6463

feat(auto-edits): adding autoedits onboarding setup for dotcom users #6463

Conversation

hitesh-1997 commented Dec 26, 2024 • edited Loading

Test plan

Choose a reason for hiding this comment

hitesh-1997 Jan 7, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hitesh-1997 Jan 7, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hitesh-1997 Jan 8, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

valerybugakov left a comment

Choose a reason for hiding this comment

hitesh-1997 commented Dec 26, 2024 •

edited

Loading

hitesh-1997 Jan 7, 2025 •

edited

Loading

hitesh-1997 Jan 7, 2025 •

edited

Loading

hitesh-1997 Jan 8, 2025 •

edited

Loading